From: Julien Grall <jgrall@amazon.com>
Date: Fri, 1 Jul 2022 17:27:05 +0000 (+0100)
Subject: public/io: xs_wire: Document that new errors should be added at the end
X-Git-Tag: archive/raspbian/4.17.0-1+rpi1^2~33^2~493
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=bf2f989531ad3851685a1847cbc1e28901ed80a2;p=xen.git

public/io: xs_wire: Document that new errors should be added at the end

Some tools (e.g. xenstored) always expect EINVAL to be first in xsd_errors.

To be conservative, mandate that new errors should be added at the end
of the array.

Signed-off-by: Julien Grall <jgrall@amazon.com>
Reviewed-by: Henry Wang <Henry.Wang@arm.com>
Reviewed-by: Juergen Gross <jgross@suse.com>
---

diff --git a/xen/include/public/io/xs_wire.h b/xen/include/public/io/xs_wire.h
index b477bd0cd2..c573950fbf 100644
--- a/xen/include/public/io/xs_wire.h
+++ b/xen/include/public/io/xs_wire.h
@@ -76,6 +76,7 @@ static struct xsd_errors xsd_errors[]
 __attribute__((unused))
 #endif
     = {
+    /* /!\ New errors should be added at the end of the array. */
     XSD_ERROR(EINVAL),
     XSD_ERROR(EACCES),
     XSD_ERROR(EEXIST),